pybricks.common.BLE: Update type hints and add missing documentation#164
Conversation
| "broadcast", | ||
| "observe", | ||
| "observe_enable", |
There was a problem hiding this comment.
A couple of these aren't in the docs, so I'm not sure they are meant to be public.
There was a problem hiding this comment.
observe_enable() was undocumented, but mentioned in the release changelog. I could extract that into a separate MR if you'd rather not add it to the public docs.
There was a problem hiding this comment.
ping @laurensvalk - just checking in whether you've seen this.
There was a problem hiding this comment.
Thanks for your patience! We're now getting around to updating the docs to match the implementation.
observe_enable was a workaround for a bug on Technic Hub, but it has been worked around internally so it was dropped in pybricks/pybricks-micropython@023d6f6#diff-4ac5e4af4cd98cb94f67e215e8d64eafd56bf7cc96f4d75637abfc4df5e51956
Update type hint for broadcast_channel to Optional, as None is allowed.
- Add overloads for broadcast(). It accepts either a single value, or a tuple, or a list. - Adjust return type of observe(). It either returns a single value, or a tuple.
laurensvalk
force-pushed
the
ble-type-fixes
branch
from
a53f371 to
5f64082
Compare
|
Merged, thanks! |
3 participants
Hi @laurensvalk and @dlech
I'm implementing the Pybricks BLE interfaces in my pybricks-ble project, and noticed that some of the type hints are inaccurate/incomplete. That makes the type checker unhappy when trying to mimic Pybricks behaviour, but with the changes in this PR I was able to get everything working (see fkleon/pybricks-ble#9).
Update API docs and code completions for the following changes:
broadcast_channelin the hub constructors, and addition of thebroadcast_enable()method: pybricks.common.BLE: Implement observe_enable() pybricks-micropython#269 (changed inv3.6.0b2)broadcastaccepts either a single value, a tuple, or a list.observeeither returns a single value, or a tuple. (changed inv3.3.0b9)